Skip to content

Chore: Setup "Jan Improvements Proposal" workflow #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 3, 2023
Merged

Chore: Setup "Jan Improvements Proposal" workflow #534

merged 2 commits into from
Nov 3, 2023

Conversation

@dan-menlo
Copy link
Contributor

@dan-menlo dan-menlo commented Nov 3, 2023 •
edited
Loading

Overview

  • We will use a proposal-based system for improvements to Jan
  • We will use adopt a system inspired by https://github.com/ethereum/EIPs
  • Proposals will be a combination of "Product Spec" and "Architectural Decision Record"
  • We will use Github Discussions for proposal discussions

Tasks

  • Use /specs instead of /adrs so people can understand it more easily (or confused with tests?)
  • Update Makefile to reflect new commands (make spec)
  • Draft "Jan Improvement Proposal" template
  • Migrate @louis-jan's JIP-001

dan-menlo
dan-menlo commented Nov 3, 2023
View reviewed changes
specs/jan-001-log-framework.md
@@ -0,0 +1,101 @@
# jan-001: Application Logs Framework
Copy link
Contributor Author

@dan-menlo dan-menlo Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@louis-jan I prefer this format, where new Improvement Proposals are opened as PRs on Github. Everyone can then comment in-line and discuss

@dan-menlo dan-menlo marked this pull request as ready for review November 3, 2023 09:27
@dan-menlo
Copy link
Contributor Author

dan-menlo commented Nov 3, 2023

@louis-jan Can I request a review? I'd like to merge and then start writing jan-002: app framework

@dan-menlo dan-menlo merged commit 1aa5990 into main Nov 3, 2023
@dan-menlo dan-menlo deleted the adr-to-specs branch November 3, 2023 09:35
@dan-menlo dan-menlo mentioned this pull request Nov 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@louis-jan louis-jan louis-jan approved these changes

Assignees

No one assigned

Labels

None yet

Projects

No open projects
Menlo
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dan-menlo @louis-jan